home *** CD-ROM | disk | FTP | other *** search
/ System Booster / System Booster.iso / Archivers / WBx / README < prev    next >
Text File  |  1996-09-26  |  8KB  |  200 lines
  1. --------------------------------------------------------
  2.            WBx - The Workbench Xtractor
  3. --------------------------------------------------------
  4.  
  5. 0. Legal Stuff
  6. --------------
  7.  
  8. WBx was written by Hans-Jörg Frieden, of DIgital DImensions.
  9.  
  10. WBx is © 1995 by DIgital DImensions.
  11.  
  12. WBx may be freely distributed in any way, as long as  it  is
  13. not  sold  as  a  separate  product.  It  may be included in
  14. PD/Shaerware Collections, including CD-Roms, as  long  as  a
  15. nominal  fee  is  charged. Explicit permission is granted to
  16. Fred Fish for inclusion into the FreshFish/GoldFish  CD-Roms
  17. series  or  any  CD-Rom  he may be producing, as well as the
  18. Aminet CD-Rom series. You are free to use it as you see fit.
  19. Read the disclaimer below.
  20.  
  21. To contact DIgital DImensions, write to:
  22.  
  23.     Hans-Joerg Frieden                  Thomas Frieden
  24.     Schloßstraße 176                    Schloßstraße 176
  25.     54293 Trier                         54291 Trier
  26.     Germany                             Germany
  27.     ++ (0) 49 651 66410                 ++ (0) 49 651 66410
  28.  
  29.     Internet:                           Internet:
  30.     hfrieden@explorer.uni-trier.de      tfrieden@explorer.uni-trier.de
  31.     inf01@uni-trier.de                  inf02@uni-trier.de
  32.     hfrieden@treveris.uni-trier.de      tfrieden@treveris.uni-trier.de
  33.  
  34. Disclaimer:
  35. Neither the  author  nor  DIgital  DImensions  can  be  held
  36. responsible  for  any  damage  caused by the use or abuse of
  37. this product, even if the damage was a direct consequence of
  38. programming  errors within the program. You use this program
  39. completely at your own risk. There's no warranty.
  40.  
  41. To sum it up: IT WASN'T MY FAULT!!!!
  42.  
  43. Source code is not included with the program.  If  you  need
  44. it, you may contact us (EMail please).
  45.  
  46. Suggestions, Bug reports, and  general  opinions  should  be
  47. sent to one of the addresses above. If you find this program
  48. useful, please let me know.
  49.  
  50.  
  51. 1. What is this, anyway?
  52. ------------------------
  53.  
  54. WBx is a small utility (~12 KB) to extract archives from the
  55. workbench.  WBx  offers  three  possibilities to specify the
  56. command with which the extraction will be done.
  57.  
  58. The motivation for writing this program came when I got  the
  59. Amiga  PLUS  CD-Rom.  Lots  of archives on them, and no menu
  60. program or navigator to let you  unpack  them.  Furthermore,
  61. the  included  Zoom program didn't quite work on my machine,
  62. so I had to go to Shell all the time to  unpack  the  stuff.
  63. Since I am quite lazy, I wrote this program.
  64.  
  65. WBx comes completely free of charge, and I would really like
  66. to  see  it become the default tool of may archives. It even
  67. saves you the problem of  writing  script  files  to  unpack
  68. archives.
  69.  
  70.  
  71. 2. Starting WBX
  72. ---------------
  73.  
  74. WBx must be invoked from Workbench, and it must have exactly
  75. one argument. There are many ways for invoking programs from
  76. workbench. Basically, this is:
  77.  
  78.     a) Click once on the WBx icon, hold down shift and double-
  79.        click on an archive's project icon
  80.  
  81.     b) Enter WBx as a default tool into an archives project icon.
  82.  
  83.     c) Enter WBx as a default tool into any def_xxx.info project
  84.        icon. This requires that you have something like 'Icon' or
  85.        'deficons' running.
  86.  
  87. You could also use a dock program like ToolManager, but make
  88. sure  that  this dock program can launch programs as if they
  89. are launched from workbench. ToolManager does this job.
  90.  
  91. 3. Using WBx
  92. ------------
  93.  
  94. Regardless of the way it was launched, WBx  will  pop  up  a
  95. window, which will look roughly like this:
  96.  
  97. +---------------------------------------------------------+
  98. |          Commandline:    [ <Use Brainfile>            ] |
  99. | Extract from Archive:    [ blah.lha                   ] |
  100. |           Extract to:    [ RAM:              ] (Select) |
  101. |                                                         |
  102. |                                 ( Extract )  ( Cancel ) |
  103. +---------------------------------------------------------+
  104.  
  105. ( [ ... ] stands for a string gadget, (...) for a button )
  106.  
  107. The "Commandline:" parameter contains the command line which
  108. will  be  invoked as soon as you press the "Extract" Button.
  109. The term "<Use brainfile>" means that this command line will
  110. be taken from the config file, i.e. there wasn't a tool type
  111. 'CMDLINE' in the icon (we'll get to Tool Types  later).  You
  112. may  enter  your  own  command  line  here  if you must, but
  113. generally this won't be needed.
  114.  
  115. "Extract from Archive:" is the archive name. You should  not
  116. change  this field in any way. It is mainly provided for the
  117. case that an archive program must specify the  archive  name
  118. in  a  different  way,  i.e.  a  programm  that would search
  119. xxx.lha.lha if you specify xxx.lha. I don't know of  such  a
  120. program, but...
  121.  
  122. "Extract to:" specifies the target path  where  the  archive
  123. will  be  extracted.  You  can change this with the "Select"
  124. button, which will pop up an asl directory requester.  NOTE:
  125. Some  programs,  like lha, require that the path ends with a
  126. ':' or '/'. WBx automatically adds a colon or slash if there
  127. wasn't  one entered. For DMS types programs, you can enter a
  128. device like DF0: here.
  129.  
  130. Pressing "Extract" starts the extraction.  "Cancel"  or  the
  131. window's close box simply exit.
  132.  
  133. 4. Specifing the command line
  134. -----------------------------
  135.  
  136. 4.1 Tool Types
  137.  
  138. WBx supports a set  of  three  Tool  Types,  which  must  be
  139. specified in the project's icon. These are:
  140.  
  141. CMDLINE=<commandline>
  142. A complete commandline to be executed by WBx. There are  two
  143. "joker" characters available, %a and %p. %a inserts the name
  144. of the archive in the final command line, %p does  the  same
  145. with  the  target  path. For example, a CMDLINE tooltype for
  146. the well-known LHA program would look like this:
  147.  
  148.     LHA x %a %p
  149.  
  150. These jokers may also be used in the brainfile (see  below).
  151. Note  also that the CMDLINE tool type overrides any entry in
  152. the brain file.
  153.  
  154. FILETYPE=<filetype>
  155. The type of the referenced archive. A filetype may be up  to
  156. four  letters  in length. Given a filetype, WBx searches its
  157. brain file for a matching entry, and uses this  file  type's
  158. command line. Note that file types are case sensitive.
  159.  
  160. DEFPATH=<path>
  161. Independent of the two above, you may also  give  a  default
  162. path  other  than "RAM:". This tool type works independently
  163. from the two above, and is useful for DMS-type programs that
  164. want  a  device  as the target. Simply specify DEFPATH=DF0:,
  165. and DMS will write to the floppy.
  166.  
  167. 4.2 Brain file
  168. When no CMDLINE is given in the  icon,  the  brain  file  is
  169. searched  for. There are two possible sources of information
  170. for the file type which is sought. First, as noted above,  a
  171. FILETYPE  can  be  specified  in the icon. Failing this, WBx
  172. chops off the extension of the file, capitalizes it and uses
  173. this as a filetype. For example, an archive named 'blah.lha'
  174. would be converted to filetype LHA. This means that for this
  175. feature  to work, you'll have to specify your file types all
  176. in caps...
  177.  
  178. Anyway,   the   brain   file,   which    must    be    named
  179. 'ENV:WBx.config', will have to look something like this:
  180.  
  181.  
  182. ; WBx Brain file
  183.  
  184. LHA  sys:bin/lha x %a %p
  185. DMS  sys:bin/dms write %a to %p
  186. ZOM  sys:bin/Zoom from %a to %p
  187. ZIP  execute s:UnZip %a %p
  188. SFX  %a %p
  189.  
  190.  
  191. Lines  which  start  with  either  a  ';'  or  a  blank  are
  192. considered  comments.  All  other  lines  are  in the format
  193. FILETYPE CMDLINE, where FILETYPE is the type  of  the  file,
  194. extended to four characters, i.e. fill the rest with blanks.
  195. CMDLINE must start at column 6 (look at  the  above  example
  196. for  clarity). Within the CMDLINE, the same joker characters
  197. can be used as was stated with the CMDLINE tool  type.  Make
  198. sure  to  save  your  brain  file to ENVARC: too, or changes
  199. you've made will not survive reset.
  200.